Document relative link resolution in MDX files#5384
Merged
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
reviewed
Apr 24, 2026
ethanpalm
reviewed
Apr 24, 2026
ethanpalm
reviewed
Apr 24, 2026
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
ethanpalm
reviewed
Apr 24, 2026
ethanpalm
reviewed
Apr 24, 2026
ethanpalm
approved these changes
Apr 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
./and../) including how they resolve inindex.mdxfilesRelative links in MDX files now resolve correctly based on the source file's location. Previously, relative paths like
./fooinindex.mdxfiles resolved against the wrong directory, causing broken links.Note
Low Risk
Documentation-only updates describing relative path (
.//../) behavior (includingindex.mdxresolution) with no runtime or API changes, so risk is minimal.Overview
Clarifies internal linking guidance by documenting support for relative paths (
./,../), including how they resolve fromindex.mdxdirectories and that fragments/query strings are preserved.Updates the FAQ to position root-relative links as the default recommendation while noting relative links can break more easily when files move.
Reviewed by Cursor Bugbot for commit 8b5e11c. Bugbot is set up for automated code reviews on this repo. Configure here.